[기능구현#7] 파일 업로드

실행 환경

같은 폴더의 “[리팩터링] 게시판 프로젝트 아키텍처” 노트에 명시된 스택 기준 — Spring Boot 3.3.5, Java 17, H2 Database, Thymeleaf.

파일 업로드

기본적으로,
파일을 업로드하는 방식에는 파일 자체를 받아서 DB에 적재하는 방법이 있고, 
파일경로만 저장을 한 후, spring server 에 저장되어있는 파일을 불러와서 사용하는 방식이 있다.
DB에 파일을 적재하는 방식은 조회하는데에도 영향이 있고, DB사이즈가 커지는 부담도 있어서 2번째 방식인 파일경로를 저장하는 방식을 택했다. 참고)
spring의 경우, 기본적으로 파일업로드를 할 수 있는 제한 사이즈는 1MB이다.
(spring.servlet.multipart.max-file-size=5MB) application.properties에서 수정 가능함

파일 도메인

• uploadFile의 이름은 업로드 당시에 사용한 이름
• storeFileName의 경우 서버에 적재할 파일 이름이다 

구분한 이유 : 서버 적재시 이름이 중복될 우려가 있기에 서버 적재 이름의 경우 UUID를 사용하여 중복을 방지하였고, 마지막에 확장자명을 구분하여 저장하도록 구현하였다.

public class UploadFile {
 
    private String uploadFileName;
    private String storeFileName;
 
    public UploadFile(){}
 
    @JsonCreator
    public UploadFile(@JsonProperty("uploadFileName") String uploadFileName, @JsonProperty("storeFileName") String storeFileName) {
        this.uploadFileName = uploadFileName;
        this.storeFileName = storeFileName;
    }
}

파일 업로드 구현

• 여러개 파일 저장 + 한개 파일 저장 구현
  • MultiPartFile을 이용하여 타입을 구분하였고, storeFiles 와 storeFile을 이용하여 여러개 파일 + 한개 파일 저장하는 방식을 구현하였다

public List<UploadFile> storeFiles(List<MultipartFile> multipartFiles) throws IOException{
        List<UploadFile> storeFileResult = new ArrayList<>();
        for (MultipartFile multipartFile : multipartFiles) {
            if (!multipartFile.isEmpty()){
                storeFileResult.add(storeFile(multipartFile));
            }
        }
        return storeFileResult;
    }
 
    public UploadFile storeFile(MultipartFile multipartFile) throws IOException{
        if (multipartFile.isEmpty()){
            return null;
        }
 
        String originalName = multipartFile.getOriginalFilename();
        String storeFileName = createStoreFileName(originalName);
        multipartFile.transferTo(new File(getFullPath(storeFileName)));
        return new UploadFile(originalName, storeFileName);
    }

파일 다운로드 구현

• 다운로드시, ResponseEntity를 이용하여 file 자체를 body에 실어서 Response 응답값으로 제공
  • Header : CONTENT_DISPOSITION으로 다운로드 명시
    • contentDisposition : “attachment; filename= ~”;
    • attachment로 파일로 저장이라는 것을 명시

@GetMapping("/attach/{id}")
    public ResponseEntity<Resource> downloadAttach(@PathVariable Long id) throws MalformedURLException{
 
        Board board = boardRepository.findByBoard(id);
        if (board == null || board.getAttachFile() == null) {
            return ResponseEntity.notFound().build(); // 파일이 없을 경우 예외 처리
        }
 
        String storeFileName = board.getAttachFile().getStoreFileName();
        String uploadFileName = board.getAttachFile().getUploadFileName();
 
        UrlResource resource = new UrlResource("file:" + fileStore.getFullPath(storeFileName));
 
        String encodedUploadFileName = UriUtils.encode(uploadFileName, StandardCharsets.UTF_8);
        String contentDisposition = "attachment; filename=\"" + encodedUploadFileName + "\"";
 
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, contentDisposition)
                .body(resource);
    }

아쉬운점)

• 구현하기에 급급하여 파일 저장 및 간단한 파일 삭제 Flow만 추가하였다.
• 그안에서 벌어지는 Transaction 관리를 하지 못하였고, 정해지지 않은 요구사항으로 인해 단순한 기능이 되었다.
• 저장 처리 로직 및 삭제 로직에 대해 다시 리팩터링을 해봐야할 필요성이 존재한다

관련 문서

• (게시판 프로젝트) [리팩터링] 게시판 프로젝트 아키텍처 — 이 파일 업로드 기능이 속한 게시판 프로젝트의 전체 아키텍처 개요